Skip to main content
POST
/
payments
/
withdraw
/
bank
/
{id}
Withdrawal (NGN | GHS)
curl --request POST \
  --url https://api.breet.io/v1/payments/withdraw/bank/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Breet-Env: <api-key>' \
  --header 'x-app-id: <api-key>' \
  --header 'x-app-secret: <api-key>' \
  --data '
{
  "amount": 500,
  "narration": "Breet payout",
  "externalId": "your-unique-reference"
}
'
{ "message": "withdrawal request received", "success": true, "data": { "id": "69737a8036d3c2b38fbaf3d9" }, "meta": {}, "summary": {}, "stats": {} }

Authorizations

​
x-app-id
string
header
required

Your application ID from the Breet dashboard

​
x-app-secret
string
header
required

Your application secret from the Breet dashboard

​
X-Breet-Env
string
header
required

Environment selector: development or production

Path Parameters

​
id
string
required

ID of the saved bank account to withdraw to.

Body

application/json
​
amount
number
required

Withdrawal amount in USD. Breet converts to the recipient's local currency (NGN or GHS) based on their country.

​
narration
string

Optional note that appears on the bank statement. Maximum 32 characters.

​
externalId
string

Your unique reference for this withdrawal. Can be used to retrieve the withdrawal later.

Response

Bank withdrawal initiated successfully